Skip to content

test: add Vale auto-fix test page with intentional violations#578

Closed
jth-nw wants to merge 3 commits intodevfrom
test/vale-autofix-v4
Closed

test: add Vale auto-fix test page with intentional violations#578
jth-nw wants to merge 3 commits intodevfrom
test/vale-autofix-v4

Conversation

@jth-nw
Copy link
Collaborator

@jth-nw jth-nw commented Mar 20, 2026

No description provided.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jth-nw jth-nw requested a review from a team as a code owner March 20, 2026 00:05
@github-actions
Copy link
Contributor

Vale Auto-Fix Summary

9 issues fixed, 0 skipped across 1 files

Category Fixes
AllowsYouTo (rewrite) 1
BoilerplateCrossRef (rewrite) 1
FirstPersonPlural (rewrite) 1
HeadingPunctuation (rewrite) 3
NoteThat (rewrite) 1
OnceUsage (rewrite) 1
WeakLinkText (rewrite) 1

Ask @claude on this PR if you'd like an explanation of any fix.

@github-actions
Copy link
Contributor

Documentation PR Review

Editorial Review

This file is explicitly a test page containing intentional style violations — all flagged patterns (passive voice, weak link text, first person, etc.) are there by design and labeled as such. No unintentional editorial issues found beyond the intentional violations.

One minor observation:

  • Clarity — Line 9: "It contains intentional violations." doesn't distinguish between Phase 1 and Phase 2 categories. A one-sentence note explaining the two-phase structure (e.g., "Phase 1 violations are fixed by script; Phase 2 violations are fixed by AI.") would help maintainers understand the test design at a glance.

Summary

0 Dale issues, 1 editorial suggestion across 1 file.


What to do next:
Comment @claude on this PR followed by your instructions. For example:

  • @claude fix all issues
  • @claude fix only the Dale issues
  • @claude reorganize the prerequisites section
  • @claude help improve the flow of this document

Automated fixes are only available for branches in this repository, not forks.

@jth-nw
Copy link
Collaborator Author

jth-nw commented Mar 20, 2026

@claude explain what you fixed in the vale issues

@github-actions
Copy link
Contributor

Here's a breakdown of the 9 Vale issues fixed by the auto-fix workflow on this PR.


Phase 1: Script fixes (mechanical substitutions and removals)

These were applied by the auto-fix script before the AI pass. They aren't counted in the summary table above, but you can see them in commit d2cfc250.

What changed Rule
Make sure youensure MakeSure substitution
check boxcheckbox, drop-downdropdown compound word substitutions
Click onClick, right-click onright-click ClickOn removal
do not / does not / cannot → contractions contraction substitutions
In order to utilizeto use, setupset up wordiness/spelling substitutions
provides the ability tolets you AllowsYouTo-family substitution
wish to loginwant to log in, is able tocan substitutions
Please configureconfigure Please removal
aforementioned removed, currently removed filler word removals
user(s)users, item(s)items parenthetical plural removal
Extra spaces after punctuation whitespace normalization
please make sure to setupensure to set up trailer line fix

Phase 2: AI fixes (the 9 in the summary table)

These required judgment and were applied by Claude in commit fc5157c0.

AllowsYouTo (1)

The system allows you to configure multiple connections.
Use the system to configure multiple connections.

The AllowsYouTo rule flags the pattern "allows you to <verb>" as indirect. Rewritten to lead with the action.

BoilerplateCrossRef (1)

For more information, click [here](./index.md).
See the [Vale Auto-Fix Test Page overview](./index.md).

BoilerplateCrossRef flags the generic "For more information" opener paired with a bare link. Rewritten to describe what the reader will find at the destination.

FirstPersonPlural (1)

We recommend that our users configure the monitoring plan before deployment.
Configure the monitoring plan before deployment.

FirstPersonPlural flags "we", "our", "us" in documentation. The sentence was restructured as a direct imperative.

HeadingPunctuation (3)

## Phase 1 Violations (Script Fixes)## Phase 1 Violations: Script Fixes
## Phase 2 Violations (AI Fixes)## Phase 2 Violations: AI Fixes
## Code Block (Should Not Be Modified)## Code Block: Not Modified by Script

HeadingPunctuation flags parenthetical qualifiers in headings. Rewritten using a colon to introduce the qualifier instead.

NoteThat (1)

Note that you must restart the service after making changes.
:::note admonition block

NoteThat flags "Note that..." as a weak inline callout. The correct pattern is a Docusaurus :::note admonition block.

OnceUsage (1)

Once the installation is complete, verify the service is running.
After the installation is complete, verify the service is running.

OnceUsage flags "once" when it's used as a synonym for "after" (temporal, not frequency). "After" is unambiguous.

WeakLinkText (1)

click [here](./index.md)
See the [Vale Auto-Fix Test Page overview](./index.md)

WeakLinkText flags non-descriptive link text like "here", "click here", or "this page". The link text should describe what the reader will find at the destination.

@jth-nw jth-nw closed this Mar 20, 2026
@jth-nw jth-nw deleted the test/vale-autofix-v4 branch March 20, 2026 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant